home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Amiga Format CD 49
/
Amiga Format CD49 (2000-01-17)(Future Publishing)(GB)(Track 1 of 3)[!][issue 2000-02].iso
/
-screenplay-
/
otherstuff
/
f1gplib_dev
/
autodocs
/
f1gp.doc
next >
Wrap
Text File
|
1999-12-06
|
6KB
|
195 lines
TABLE OF CONTENTS
f1gp.library/f1gpAllocQuitNotify
f1gp.library/f1gpCalcChecksum
f1gp.library/f1gpDetect
f1gp.library/f1gpFreeQuitNotify
f1gp.library/f1gpGetDisplayInfo
f1gp.library/f1gpRequestNotification
f1gp.library/f1gpStopNotification
f1gp.library/f1gpAllocQuitNotify f1gp.library/f1gpAllocQuitNotify
NAME
f1gpAllocQuitNotify -- ask to be notified when F1GP quits.
SYNOPSIS
handle = f1gpAllocQuitNotify( task, signal )
D0 A0 D0
APTR f1gpAllocQuitNotify( struct Task *, ULONG );
NOTES
This function is obsolete, please use f1gpRequestNotification()
instead.
SEE ALSO
f1gpRequestNotification()
f1gp.library/f1gpCalcChecksum f1gp.library/f1gpCalcChecksum
NAME
f1gpCalcChecksum -- Compute a standard F1GP file checksum. (V35)
SYNOPSIS
checksum = f1gpCalcChecksum( data, datasize )
D0 A0 D0
ULONG f1gpCalcChecksum( UBYTE *, ULONG );
FUNCTION
If you intend to alter any of F1GP's files (eg track files), you
will need to rewrite the 4 byte checksum also (last 4 bytes of file).
This function calculates the correct checksum from the given input
data and returns it as a ULONG.
INPUTS
data - a pointer to the array of bytes which you intend to save.
datasize - the size of the data array (in bytes), NOT including the
checksum space (4 bytes).
RESULTS
checksum - the 4 byte checksum that is usually located at the end
of F1GP's files (ie the last 4 bytes).
f1gp.library/f1gpDetect f1gp.library/f1gpDetect
NAME
f1gpDetect -- Inquire whether F1GP is running in memory.
SYNOPSIS
type = f1gpDetect();
D0
LONG f1gpDetect( void );
FUNCTION
This function scans the Exec task lists to determine whether F1GP
is currently running in memory. If F1GP is resident then the type
is returned and HunkStart, Seg1, Seg3 in the F1GPBase structure
will be updated. The type is also stored in the F1GPType field
in the F1GPBase structure.
Each time this function is called the priority of F1GP is set to
-100, to stop it hogging processor time.
Importantly, this function also automatically applies a number of
patches to F1GP which fix bugs and provide enhancements.
RESULTS
type - if F1GP was detected in memory, this will be indicate
what version of F1GP it is. This will be one of
F1GPTYPE_STANDARD, F1GPTYPE_WC or F1GPTYPE_A600WWW.
If not detected, the value will be 0.
f1gp.library/f1gpFreeQuitNotify f1gp.library/f1gpFreeQuitNotify
NAME
f1gpFreeQuitNotify -- Free memory after f1gpAllocQuitNotify().
SYNOPSIS
f1gpFreeQuitNotify( handle )
A0
void f1gpFreeQuitNotify( APTR );
NOTES
This function is obsolete, please use f1gpStopNotification()
instead.
SEE ALSO
f1gpStopNotification()
f1gp.library/f1gpGetDisplayInfo f1gp.library/f1gpGetDisplayInfo
NAME
f1gpGetDisplayInfo -- Obtain information about the F1GP display
SYNOPSIS
dispinfo = f1gpGetDisplayInfo()
D0
struct F1GPDisplayInfo *f1gpGetDisplayInfo( void );
FUNCTION
Returns a pointer to a structure containing low-level information
on the current F1GP display. Under no circumstances should you
modify this data (it is read only). The sole intention of this
function is to allow the GPPatch patch in F1GP-Ed to work
correctly, when the AGA faster fetchmode and/or hardware scan
doubling patches are enabled. Therefore, it is unlikely that you
will need to use this function.
SEE ALSO
f1gp.library/f1gpRequestNotification f1gp.library/f1gpRequestNotification
NAME
f1gpRequestNotification -- ask to be notified when selected
F1GP events occur. (V36)
SYNOPSIS
handle = f1gpRequestNotification( msgport, events )
D0 A0 D0
APTR f1gpRequestNotification( struct MsgPort *, ULONG )
FUNCTION
This function allows a task to be notified instantly when certain
events occur in F1GP. Multiple events can be requested by ORing
the event flags together.
When a requested event occurs, a F1GPMessage will be sent to the
message port where you should process it and ReplyMsg() it.
This call MUST be matched with a call to f1gpStopNotification(),
typically just before the calling task exits.
INPUTS
msgport - pointer to a fully initialized message port, belonging to
the calling task
events - F1GPEVENT_QUITGAME - be notified when F1GP is exited by
the user (useful to allow your program to remove patches,
exit, etc, when F1GP quits)
F1GPEVENT_EXITCOCKPIT - be notified when the user exits
the cockpit (e.g. presses Esc or at the end of a session)
and the F1GP menu system returns. Can be useful if your
program needs to update anything when multitasking is
re-enabled by F1GP.
RESULTS
handle - a pointer to an internal node structure if successful,
otherwise NULL.
SEE ALSO
f1gpStopNotification()
f1gp.library/f1gpStopNotification f1gp.library/f1gpStopNotification
NAME
f1gpStopNotification -- Free all notification requests made by
f1gpRequestNotification(). (V36)
SYNOPSIS
f1gpStopNotification( handle )
A0
void f1gpStopNotification( APTR );
FUNCTION
Frees memory and resources allocated by a call to
f1gpRequestNotification(), which also means the calling task will
no longer be notified of any F1GP events. The pointer passed in
MUST have been obtained by f1gpRequestNotification().
If NULL is passed in, this function does nothing.
INPUTS
handle - pointer returned from f1gpRequestNotification() or NULL.
SEE ALSO
f1gpRequestNotification()